fix: Avatar changes when from offline to online #32090

anyongjitiger · 2023-11-28T06:52:34Z

Details

Fixed Issues

$ #28518
PROPOSAL: #28518 (comment)

Tests

Launch app
Tap on profile---Preferences
Toggle on forced offline
Tab FAB and start chat
Input email with default avatar and tab on create chat
Look at the avatar in the report
Tap on profile---Preferences
Toggle off forced offline
Go back to the chat, look at the avatar and make sure it will not change.

Verify that no errors appear in the JS console

Offline tests

Same as QA steps

QA Steps

Launch app
Tap on profile---Preferences
Toggle on forced offline
Tab FAB and start chat
Input email with default avatar and tab on create chat
Look at the avatar in the report
Tap on profile---Preferences
Toggle off forced offline
Go back to the chat, look at the avatar and make sure it will not change.

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

android.native.mp4

Android: mWeb Chrome

android.web.mp4

iOS: Native

ios.native.-.01.mp4

iOS: mWeb Safari

ios.web.-.01.mp4

MacOS: Chrome / Safari

chrome.mp4

MacOS: Desktop

desktop.mp4

melvin-bot · 2023-11-28T06:52:40Z

@jjcoffee Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

anyongjitiger · 2023-11-28T07:19:29Z

@jjcoffee
I'm sorry, I accidentally closed the previous pull request.
Closed PR
I have updated the code and sign all my commits according to your suggestions. Please review.
Sorry again.

jjcoffee · 2023-11-28T16:46:06Z

Thanks! I'll take a look tomorrow.

jjcoffee · 2023-11-29T14:34:13Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

android-native-2023-11-27_12.03.43.mp4

Android: mWeb Chrome

android-chrome-2023-11-27_11.57.58.mp4

iOS: Native

ios-native-2023-11-27_15.32.09.mp4

iOS: mWeb Safari

ios-safari-2023-11-27_15.28.54.mp4

MacOS: Chrome / Safari

desktop-chrome-2023-11-27_11.53.04.mp4

MacOS: Desktop

desktop-app-2023-11-27_15.34.25.mp4

jjcoffee · 2023-11-29T14:35:46Z

@anyongjitiger As I mentioned on the previous PR, please link to the issue itself next to the $, rather than your proposal.

jjcoffee · 2023-11-29T14:45:40Z

There are some special cases, such as deleting a custom avatar, where the updated user ID from the backend is used to calculate the avatar URL. In such cases, it is necessary to recalculate the original user ID using the user's email.

@anyongjitiger Just tested this case that you mentioned on the closed PR, but it doesn't seem to work:

desktop-chrome-remove-avatar-2023-11-29_15.43.20.mp4

jjcoffee · 2023-11-29T14:59:00Z

src/libs/UserUtils.ts

-    const accountIDHashBucket = ((accountID % CONST.DEFAULT_AVATAR_COUNT) + 1) as AvatarRange;
-
+    let accountIDHashBucket: AvatarRange;
+    if (avatarURL && /images\/avatars\/default-avatar_\d+\./.test(avatarURL)) {


I'm convinced this can be tidied up 😉 Let's only use one regex pattern and we probably don't need to test for it first if we're going to match later anyway.

Alright, I have removed it.

jjcoffee · 2023-11-29T15:01:01Z

src/libs/UserUtils.ts

-    const accountIDHashBucket = ((accountID % CONST.DEFAULT_AVATAR_COUNT) + 1) as AvatarRange;
-
+    let accountIDHashBucket: AvatarRange;
+    if (avatarURL && /images\/avatars\/default-avatar_\d+\./.test(avatarURL)) {


Let's also add an explanatory comment here as it won't be super clear why we're extracting the ID from avatarURL.

Comment added

jjcoffee · 2023-11-29T15:01:31Z

src/libs/UserUtils.ts

    if (Number(accountID) === CONST.ACCOUNT_ID.CONCIERGE) {
        return CONST.CONCIERGE_ICON_URL;
    }
-
+    let email; let originAccountID;
+    if (allPersonalDetails?.[accountID]) {


Comment also needed here to explain why this code is here.

Comment added

merge from origin branch

anyongjitiger · 2023-11-30T03:19:31Z

There are some special cases, such as deleting a custom avatar, where the updated user ID from the backend is used to calculate the avatar URL. In such cases, it is necessary to recalculate the original user ID using the user's email.

@anyongjitiger Just tested this case that you mentioned on the closed PR, but it doesn't seem to work:

desktop-chrome-remove-avatar-2023-11-29_15.43.20.mp4

@jjcoffee
It seems that the backend returned a default avatar, and it used the avatar of "newDot" instead of "oldDot".
This is the reason why the avatar changed twice after deleting it.
Do we need to change the original method when deleting avatars, instead of following what is written in the comments?

comment: // We want to use the old dot avatar here as this affects both platforms.

merge

jjcoffee · 2023-11-30T13:53:40Z

App/src/libs/actions/PersonalDetails.ts

Lines 520 to 521 in 132199c

    
           // We want to use the old dot avatar here as this affects both platforms. 
        
           const defaultAvatar = UserUtils.getDefaultAvatarURL(currentUserAccountID, false);

@anyongjitiger Looking into this a bit more, this was introduced in this PR, it's possible that I misunderstood the code and actually it's correct for the default to be isNewDot=false, as they renamed this function from getOldDotDefaultAvatar. Can you test with that, and also make sure the steps on that PR also pass?

merge

anyongjitiger · 2023-12-01T01:26:09Z

@jjcoffee
I tested the scenario in the PR, and when I set isNewDot to true, it appears to be working fine.

video.mov

jjcoffee · 2023-12-01T12:44:09Z

@anyongjitiger Great, thanks! To clarify, is that with reverting the default isNewDot = true back to isNewDot = false?

Can you also address my other comments?

merge

anyongjitiger · 2023-12-04T06:12:04Z

@anyongjitiger Great, thanks! To clarify, is that with reverting the default isNewDot = true back to isNewDot = false?

@jjcoffee

No, it's isNewDot = true here

jjcoffee · 2023-12-04T12:32:55Z

Okay I've tested and I don't see any issues in oldDot when deleting a custom avatar (even when the avatar ID exceeds OLD_DEFAULT_AVATAR_COUNT (which is 8)). So I think we're good to just remove the isNewDot param if you agree? (Don't forget to update all instances of getDefaultAvatarURL to remove the extra param).

Please can you also update the linked issue in the description (after the $) so that it links to the issue and not your proposal? Thanks!

jjcoffee · 2023-12-04T12:35:02Z

src/libs/UserUtils.ts

+    if (allPersonalDetails?.[accountID]) {
+        if (allPersonalDetails[accountID].login) {
+            email = allPersonalDetails[accountID].login;
+        } else if (allPersonalDetails[accountID].displayName) {


I wonder how useful this is, since the displayName could have changed and may no longer be an email?

OK, I have already updated my PR. Thank you.

jjcoffee · 2023-12-04T12:35:54Z

src/libs/UserUtils.ts

+        }
+    }
+    if (email) {
+        originAccountID = generateAccountID(email);


If I understand right, I think this would clearer if it was named originalOptimisticAccountID?

OK, I have updated it to originalOptimisticAccountID.

jjcoffee · 2023-12-04T12:37:37Z

src/libs/UserUtils.ts


+    // When we create a chat with a new user, an optimistic ID is used, and the avatar is generated based on it.


Can you make the comment more concise, it's a bit too long I think.

OK, I have updated the comment.

anyongjitiger · 2023-12-05T01:33:07Z

Okay I've tested and I don't see any issues in oldDot when deleting a custom avatar (even when the avatar ID exceeds OLD_DEFAULT_AVATAR_COUNT (which is 8)). So I think we're good to just remove the isNewDot param if you agree? (Don't forget to update all instances of getDefaultAvatarURL to remove the extra param).

Please can you also update the linked issue in the description (after the $) so that it links to the issue and not your proposal? Thanks!

@jjcoffee
I have removed the isNewDot param and updated the linked issue.
Please review, thank you.

jjcoffee · 2023-12-05T14:34:31Z

Thanks! Code is looking good, I will just give it a retest tomorrow and then we should be good to go.

jjcoffee

Tests well, LGTM!

melvin-bot · 2023-12-06T08:52:31Z

🎯 @jjcoffee, thanks for reviewing and testing this PR! 🎉

An E/App issue has been created to issue payment here: #32547.

jjcoffee · 2023-12-06T08:55:22Z

@anyongjitiger Sorry just noticed you left a trailing #issue in the issue link, which is breaking automation. Can you remove that so that it's just the link to the issue?

jjcoffee · 2023-12-06T08:56:27Z

@Julesssss All yours!

aimane-chnaif · 2023-12-06T09:03:35Z

src/libs/UserUtils.ts

+Onyx.connect({
+    key: ONYXKEYS.PERSONAL_DETAILS_LIST,
+    callback: (val) => (allPersonalDetails = _.isEmpty(val) ? {} : val),
+});


We should avoid this pattern.
ref: https://expensify.slack.com/archives/C01GTK53T8Q/p1688630003862989

The link doesn't work for me for some reason 😅 Can you post some more detail here maybe?

Bump on this question

Managed to get the link to load by pasting it into a chat with myself on Slack! 😆

As far as I can tell we aren't memoizing any of the calls to getDefaultAvatarURL so I don't think the issue is particularly relevant here. Many of the calls to getDefaultAvatarURL are also from ReportUtils which also uses this pattern so it wouldn't be a very useful optimization 😄

@Julesssss Friendly bump on the above - I think we should be good to merge!

OSBotify · 2023-12-15T14:43:27Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2023-12-19T02:42:48Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.14-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

OSBotify · 2023-12-19T03:46:09Z

🚀 Deployed to staging by https://github.com/Julesssss in version: 1.4.14-0 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

OSBotify · 2023-12-21T05:13:44Z

🚀 Deployed to production by https://github.com/jasperhuangg in version: 1.4.14-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	failure ❌
🕸 web 🕸	success ✅

Santhosh-Sellavel · 2024-01-25T17:32:25Z

src/libs/UserUtils.ts

+    // But the avatar link still corresponds to the original ID-generated link. So we extract the SVG image number from the backend's link instead of using the user ID directly
+    let accountIDHashBucket: AvatarRange;
+    if (avatarURL) {
+        const match = avatarURL.match(/(?<=default-avatar_)\d+(?=\.)/);


we have one more default avatar prefix avatar_ which is missed here, that caused a regression more details here

anyongjitiger added 2 commits November 28, 2023 14:25

fix: Avatar changes when from offline to online

bcb57a3

fix: Avatar changes when from offline to online

7e9768e

anyongjitiger requested a review from a team as a code owner November 28, 2023 06:52

melvin-bot bot requested review from jjcoffee and removed request for a team November 28, 2023 06:52

jjcoffee reviewed Nov 29, 2023

View reviewed changes

Merge remote-tracking branch 'upstream/main'

3d2086a

merge from origin branch

Merge remote-tracking branch 'upstream/main'

132199c

merge

Merge remote-tracking branch 'upstream/main'

61c4ad0

merge

anyongjitiger added 4 commits December 4, 2023 08:38

Merge remote-tracking branch 'upstream/main'

a9d8b7c

fix: remove redundant validation

533d90f

fix: use newDot avatar

87fb8e7

Merge remote-tracking branch 'upstream/main'

0bac8d7

merge

jjcoffee reviewed Dec 4, 2023

View reviewed changes

anyongjitiger added 3 commits December 5, 2023 07:59

merge branch expensify main

874fe34

fix: remove param in getDefaultAvatarURL

f66f6a1

merge

674d060

anyongjitiger mentioned this pull request Dec 5, 2023

[HOLD for payment 2023-12-28] [$500] Chat - Avatar of a new user changes when switching from offline to online #28518

Closed

6 tasks

jjcoffee approved these changes Dec 6, 2023

View reviewed changes

melvin-bot bot mentioned this pull request Dec 6, 2023

Payment issue for E/App PR#32090 #32547

Closed

Julesssss previously approved these changes Dec 6, 2023

View reviewed changes

aimane-chnaif reviewed Dec 6, 2023

View reviewed changes

fix: prettier

fe5a7d9

anyongjitiger dismissed Julesssss’s stale review via fe5a7d9 December 7, 2023 01:02

Julesssss assigned anyongjitiger Dec 11, 2023

Julesssss approved these changes Dec 15, 2023

View reviewed changes

Julesssss merged commit ab138ee into Expensify:main Dec 15, 2023
20 checks passed

jjcoffee mentioned this pull request Dec 18, 2023

[HOLD for payment 2024-01-02] [$500] App unusable on Safari 16.3 #33215

Closed

6 tasks

github-actions bot mentioned this pull request Dec 19, 2023

Deploy Checklist: New Expensify 2023-12-19 #33264

Closed

98 tasks

situchan mentioned this pull request Dec 19, 2023

fix older safari launch app issue #33238

Merged

58 tasks

jjcoffee mentioned this pull request Jan 22, 2024

[$500] Contact Method - The profile avatar changes when the default contact email is updated #34815

Closed

6 tasks

Santhosh-Sellavel reviewed Jan 25, 2024

View reviewed changes

Santhosh-Sellavel mentioned this pull request Jan 25, 2024

[HOLD for payment 2024-01-24] [$500] Profile - No profile image displayed for specific users in header&profile page #33452

Closed

6 tasks


		// When we create a chat with a new user, an optimistic ID is used, and the avatar is generated based on it.

fix: Avatar changes when from offline to online #32090

fix: Avatar changes when from offline to online #32090

Conversation

anyongjitiger commented Nov 28, 2023 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

melvin-bot bot commented Nov 28, 2023

anyongjitiger commented Nov 28, 2023

jjcoffee commented Nov 28, 2023

jjcoffee commented Nov 29, 2023 • edited Loading

Reviewer Checklist

Screenshots/Videos

jjcoffee commented Nov 29, 2023

jjcoffee commented Nov 29, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anyongjitiger commented Nov 30, 2023

jjcoffee commented Nov 30, 2023

anyongjitiger commented Dec 1, 2023

jjcoffee commented Dec 1, 2023

anyongjitiger commented Dec 4, 2023

jjcoffee commented Dec 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

anyongjitiger commented Dec 5, 2023

jjcoffee commented Dec 5, 2023

jjcoffee left a comment

Choose a reason for hiding this comment

melvin-bot bot commented Dec 6, 2023

jjcoffee commented Dec 6, 2023

jjcoffee commented Dec 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

OSBotify commented Dec 15, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 19, 2023

OSBotify commented Dec 21, 2023

Choose a reason for hiding this comment

anyongjitiger commented Nov 28, 2023 •

edited

Loading

jjcoffee commented Nov 29, 2023 •

edited

Loading